home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / util / misc / NoteIt_1_3a.lha / NoteIt!-1.3 / NoteIt!.doc < prev    next >
Encoding:
Text File  |  1993-08-18  |  6.6 KB  |  186 lines
  1.  
  2.                              NoteIt!
  3.                              ><>-<><
  4.                              
  5.                    Version 1.3a   August 18, 1993
  6.  
  7.                         by  Ryan J. Bruner
  8.  
  9. I.  Why?
  10. ========
  11. I always felt the Amiga needed a short little Post-It© style utility.
  12. Too often while using my computer, I need to leave myself a note, but
  13. don't because I never have some paper and a pen.  So, I decided to try
  14. my hand at it.  This is my first attempt at any Amiga Intuition 
  15. programming, so any suggestions you have are welcomed! 
  16.  
  17. Note:  I cannot be responsible for any system crashes caused
  18.        by this program.  :-)  I just hope they don't happen!
  19.        I have tried to thoroughly test this.
  20.  
  21. II. What?
  22. =========
  23. A.  Startup
  24. -----------
  25. NoteIt! requires at least Workbench 2.0 to run.  NoteIt! can be
  26. started by either the CLI, or from the Workbench.  Several parameters
  27. are supported to configure NoteIt!.  These parameters are the same
  28. for the CLI as for the Workbench Tooltypes.  These Tooltypes are as
  29. follows:
  30.  
  31. TOP            You can specify the where the top of the NoteIt! window
  32.                will open using this Tooltype.  For example, to open
  33.                the window 100 pixels from the top of the screen, use
  34.                "TOP=100".  The default position is 20.
  35.  
  36. LEFT           Similar to TOP, except you can specify where the left
  37.                edge of the window will open.  Default position is 20.
  38.  
  39. PUBSCREEN      You can specify which Public screen NoteIt! will open 
  40.                on with this Tooltype.  If the Public screen does not
  41.                exist, then it will default to the Workbench.
  42.  
  43. WIDTH          Using WIDTH tells NoteIt! how many pixels across the 
  44.                window should be.  For example, to to have a window
  45.                300 pixels across, use "WIDTH=300".
  46.                Default is 100.
  47.  
  48. HEIGHT         Similar to WIDTH, except you can specify the number of
  49.                pixels up and down that can be displayed.  If you specify
  50.                fewer than the default, then NoteIt! will use the default.
  51.                Actual default varies with font size..
  52.  
  53.  
  54. These Tooltypes are identical to the parameters that may be passed to 
  55. the CLI.  For example, to open NoteIt! with a top edge at 100, and
  56. left edge at 100, you would enter:
  57.  
  58.                NoteIt! TOP=100 LEFT=100
  59.  
  60.             
  61. B.  Using NoteIt!
  62. -----------------
  63. NoteIt! allows you to type enough text to fill the window.  The 
  64. window's font is determined by the current screen's default font.
  65. Once the window opens, you can type text at will.  NoteIt! supports
  66. multiple pages in the window, allowing you to leave yourself several 
  67. messages with only one NoteIt! program running.  NoteIt! will only
  68. allow you to run one at a time.  This is necessary since having more 
  69. than one running could erase the notes in the note file with the
  70. notes of another.  See below for more on the note files.
  71.  
  72.  
  73. B-1 Menus
  74. ---------
  75. * Under the Project menu, there are 2 menu items:
  76.  
  77. About NoteIt!...    
  78.  I'm sure you can figure out what it does!  :-)
  79.  
  80. Zip Window
  81.  Choosing this item, or clicking on the size gadget of the
  82.  window will "zip" the window to the size of the title bar.
  83.  All functions are disabled except for through the gadgets
  84.  this way.  Click on the size gadget to return to the 
  85.  previous size and location.
  86.  
  87. Quit
  88.  This will quit out of NoteIt!, saving any remaining notes.  
  89.  (see section about saving notes below).  Amiga-Q or using 
  90.  the Close Gadget perform the same function.
  91.  
  92. * Several menu items are listed under the Page menu:
  93.  
  94. Add Page
  95.  Choosing "add page" will create a new empty page to type
  96.  into.  Amiga-A is the keyboard equivilent.
  97.            
  98. Delete Page
  99.  Choosing "delete page" will delete the current page, and
  100.  advance to the next page.  If the current page is the only
  101.  page, then a requester will say you can't delete that page.
  102.  Amiga-D is the keyboard equivilent.
  103.  
  104. Next Page
  105.  Choosing "next page" will advance to the next page, if 
  106.  one exists.  Amiga-N is the keyboard equivilent.
  107.  
  108. Prev Page
  109.  Choosing "prev page" will move back to the previous page,
  110.  if one exists.  Amiga-P is the keyboard equivilent.
  111.  
  112.  
  113. B-2 Gadgets
  114. -----------
  115. There are four gadgets in the NoteIt! window:  Add Page is shown as
  116. a plus (+), Delete Page as a minus (-), Previous page as an arrow (<-),
  117. and Next Page as the opposite arrow (->).  Their functions match the 
  118. respective menu items under the Page menu above.
  119.     You can also shrink the window down to just the title bar by 
  120. clicking on the Zoom Gadget.  While the window is "zipped" to only a 
  121. title bar, menu functions, as well as keyboard input is disabled.  Just
  122. click the Zoom Gadget again to restore the window back to its original
  123. size and location.  
  124.  
  125. B-3 Saving
  126. ----------
  127. NoteIt! also will save your notes between power cycles.  All notes
  128. will be stored in a file located in "ENVARC:NoteIt.notes".  Every time
  129. NoteIt! is run, if a note file exists, it will read the file and display
  130. the first one in the window.  Use Next Page, or Prev Page to view any
  131. other notes.  
  132.     NoteIt! also saves the notes after approximately 10 seconds of
  133. inactivity.  Leaving NoteIt! running until shutting power off will not
  134. lose messages unless you shut off the power prior to the 10 second time
  135. period.  Once you close the NoteIt! window, either through the close
  136. gadget, or through the menu item "Quit" (Amiga-Q), it will save any
  137. messages.
  138.  
  139.  
  140. III. What is to come?
  141. =====================
  142. My current plans for future versions include:
  143.     
  144.   o  Support for the system clipboard
  145.   o  Multiple windows for notes.
  146.   o  NoteIt! configuration window to control window size and
  147.      font.
  148.   o  Scroll bar to scroll without the need for using the cursor.
  149.   o  Ability to insert cursor with mouse..
  150.  
  151. Any suggestions are greatly appreciated.
  152.  
  153.  
  154. IV. Who?
  155. ========
  156. I can be contacted through e-mail at the following address:
  157.  
  158.   rbruner@engin.umich.edu
  159.   
  160. or through snail mail at:
  161.  
  162.   Ryan J. Bruner
  163.   3075 Whisperwood Dr.
  164.   Apt. 448
  165.   Ann Arbor, MI  48105
  166.   USA
  167.   
  168.  
  169. V. Thanks
  170. =========
  171. I first would like to thank Christopher Wolf, a.k.a. cwolf on the IRC
  172. (chris@alchemy.tn.cornell.edu), for the ParseParameters function so I
  173. could support TOOLTYPES.
  174.  
  175. Thanks to my beta testers, Xed, Dense, JanusMan, Timmer, colins, and
  176. DrDemento, all from the IRC.
  177.  
  178. I would also like to thank Martyn Knapton, a.k.a. B-Trayor on the IRC, 
  179. for the new NoteIt! icon.  He designed several, but I could only use the
  180. smallest version until I find a way to use larger images in IconEdit.
  181.  
  182. I would like to thank all the guys on #amiga for all the assistance they
  183. have provided while programming this.
  184.  
  185. Thanks, especially, to my Lord and Saviour, Jesus Christ!
  186.